home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / zptrfs.z / zptrfs
Encoding:
Text File  |  2002-10-03  |  5.8 KB  |  199 lines

  1.  
  2.  
  3.  
  4. ZZZZPPPPTTTTRRRRFFFFSSSS((((3333SSSS))))                                                          ZZZZPPPPTTTTRRRRFFFFSSSS((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ZPTRFS - improve the computed solution to a system of linear equations
  10.      when the coefficient matrix is Hermitian positive definite and
  11.      tridiagonal, and provides error bounds and backward error estimates for
  12.      the solution
  13.  
  14. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  15.      SUBROUTINE ZPTRFS( UPLO, N, NRHS, D, E, DF, EF, B, LDB, X, LDX, FERR,
  16.                         BERR, WORK, RWORK, INFO )
  17.  
  18.          CHARACTER      UPLO
  19.  
  20.          INTEGER        INFO, LDB, LDX, N, NRHS
  21.  
  22.          DOUBLE         PRECISION BERR( * ), D( * ), DF( * ), FERR( * ),
  23.                         RWORK( * )
  24.  
  25.          COMPLEX*16     B( LDB, * ), E( * ), EF( * ), WORK( * ), X( LDX, * )
  26.  
  27. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  28.      These routines are part of the SCSL Scientific Library and can be loaded
  29.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  30.      directs the linker to use the multi-processor version of the library.
  31.  
  32.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  33.      4 bytes (32 bits). Another version of SCSL is available in which integers
  34.      are 8 bytes (64 bits).  This version allows the user access to larger
  35.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  36.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  37.      only one of the two versions; 4-byte integer and 8-byte integer library
  38.      calls cannot be mixed.
  39.  
  40. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  41.      ZPTRFS improves the computed solution to a system of linear equations
  42.      when the coefficient matrix is Hermitian positive definite and
  43.      tridiagonal, and provides error bounds and backward error estimates for
  44.      the solution.
  45.  
  46. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  47.      UPLO    (input) CHARACTER*1
  48.              Specifies whether the superdiagonal or the subdiagonal of the
  49.              tridiagonal matrix A is stored and the form of the factorization:
  50.              = 'U':  E is the superdiagonal of A, and A = U**H*D*U;
  51.              = 'L':  E is the subdiagonal of A, and A = L*D*L**H.  (The two
  52.              forms are equivalent if A is real.)
  53.  
  54.      N       (input) INTEGER
  55.              The order of the matrix A.  N >= 0.
  56.  
  57.      NRHS    (input) INTEGER
  58.              The number of right hand sides, i.e., the number of columns of
  59.              the matrix B.  NRHS >= 0.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ZZZZPPPPTTTTRRRRFFFFSSSS((((3333SSSS))))                                                          ZZZZPPPPTTTTRRRRFFFFSSSS((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      D       (input) DOUBLE PRECISION array, dimension (N)
  75.              The n real diagonal elements of the tridiagonal matrix A.
  76.  
  77.      E       (input) COMPLEX*16 array, dimension (N-1)
  78.              The (n-1) off-diagonal elements of the tridiagonal matrix A (see
  79.              UPLO).
  80.  
  81.      DF      (input) DOUBLE PRECISION array, dimension (N)
  82.              The n diagonal elements of the diagonal matrix D from the
  83.              factorization computed by ZPTTRF.
  84.  
  85.      EF      (input) COMPLEX*16 array, dimension (N-1)
  86.              The (n-1) off-diagonal elements of the unit bidiagonal factor U
  87.              or L from the factorization computed by ZPTTRF (see UPLO).
  88.  
  89.      B       (input) COMPLEX*16 array, dimension (LDB,NRHS)
  90.              The right hand side matrix B.
  91.  
  92.      LDB     (input) INTEGER
  93.              The leading dimension of the array B.  LDB >= max(1,N).
  94.  
  95.      X       (input/output) COMPLEX*16 array, dimension (LDX,NRHS)
  96.              On entry, the solution matrix X, as computed by ZPTTRS.  On exit,
  97.              the improved solution matrix X.
  98.  
  99.      LDX     (input) INTEGER
  100.              The leading dimension of the array X.  LDX >= max(1,N).
  101.  
  102.      FERR    (output) DOUBLE PRECISION array, dimension (NRHS)
  103.              The forward error bound for each solution vector X(j) (the j-th
  104.              column of the solution matrix X).  If XTRUE is the true solution
  105.              corresponding to X(j), FERR(j) is an estimated upper bound for
  106.              the magnitude of the largest element in (X(j) - XTRUE) divided by
  107.              the magnitude of the largest element in X(j).
  108.  
  109.      BERR    (output) DOUBLE PRECISION array, dimension (NRHS)
  110.              The componentwise relative backward error of each solution vector
  111.              X(j) (i.e., the smallest relative change in any element of A or B
  112.              that makes X(j) an exact solution).
  113.  
  114.      WORK    (workspace) COMPLEX*16 array, dimension (N)
  115.  
  116.      RWORK   (workspace) DOUBLE PRECISION array, dimension (N)
  117.  
  118.      INFO    (output) INTEGER
  119.              = 0:  successful exit
  120.              < 0:  if INFO = -i, the i-th argument had an illegal value
  121.  
  122. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  123.      ITMAX is the maximum number of steps of iterative refinement.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ZZZZPPPPTTTTRRRRFFFFSSSS((((3333SSSS))))                                                          ZZZZPPPPTTTTRRRRFFFFSSSS((((3333SSSS))))
  137.  
  138.  
  139.  
  140. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  141.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  142.  
  143.      This man page is available only online.
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.